{{indexmenu_n>4}}

====== File Structure ======


==== Pathname conventions ====
for Dokuwiki and in the URL line:

  *  Use ":" or "Colon" for  "\" or "/"
  *  Use "_" for "spaces" 
  *  Use all lowercase letters

Example URL to this page:
<code>
opencpn.org/wiki/dokuwiki/doku.php?id=opencpn:opencpn_user_manual:edit_user_manual:file_structure
</code>

This is the key part to understand:
<code>
opencpn:opencpn_user_manual:edit_user_manual:file_structure
</code>


==== Four Books File Directories and pathnames ====

Internal and external links use double square brackets and a pipe %%|%% separating the path from the Page Title.

%%[[%%opencpn:(book_namespace):(ns):(ns):file_name|Page Title %%]]%%

<code>
Namespaces for each book's Files only
-------------------------------------
[[opencpn:developer_manual:(ns):(ns):(file_name)]]  <--- Developer Manual 
[[opencpn:supplementary_software:(ns):(ns):(file_name)]] <--- Supplementary Software 
[[opencpn:supplementary_hardware:(nse):(ns):(file_name)]] <--- Supplementary Hardware
[[opencpn:opencpn_user_manual:(ns):(ns):(file_name)]]<---- OpenCPN User Manual 

ns = namespace

</code>


To create the Page Titles in the Editor, use the full filename with regular upper/lower and spaces.



==== Media Directories and pathnames ====

Image links use double braces "{" or curly or squiggly brackets and a pipe %%|%% separating the path from the Caption Title.

%%{{%%opencpn:(media_namespace):file_name|Caption Title %%}}%%

Upload files to ONLY these locations. All other files will be simply deleted on a regular basis, loosing links. FCG.
In other words make sure you get the path right please.

<code> 
Namespaces for each book's IMAGE Files only
---------------------------------
{{opencpn:manual:media_file}}    <--Opencpn User Manual
{{opencpn:software:media_file}}  <--Supplementary Software
{{opencpn:hardware:media_file}}  <--Supplementary Hardware
{{opencpn:dev:media_file}}       <--Developer Manual


Namespaces for Upload/Download Links only
-------------------------------------------
{{opencpn:files}}     <--NOT to be used for Image files.
{{opencpn:files:charts}} <--chart files for illustration purposes only!
{{opencpn:files:chartsymbols}} <--chart symbol files
{{opencpn:files:icons}}  <--icon files
{{opencpn:files:layers}} <--layer files
{{opencpn:files:palettes}} <--vector palette files
{{opencpn:files:tools}}  <--scripts and programs

</code>

In Media, Editors cannot create additional sub-directories. These are the choices.
You will be using **Media Manager** interface to Upload Files and Upload Screenshots to these directories.

[[https://www.dokuwiki.org/mime|Allowed Mime Types]] Note that html, txt and other types are not allowed due to security.
